Conversation
✅ Deploy Preview for flanksource-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for canarychecker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates several submodule references and enhances the documentation for notification silences by adding a detailed reference MDX and reorganizing the conceptual guide.
- Bump submodule commits in multiple
modules/*and the rootmission-control-chart - Introduce
_silence.mdxto document silence fields and resource selector schema - Revise
silences.mdxguide with an import, example fixture, and clearer sections on creation, filters, and recursion
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| modules/mission-control-registry | updated subproject commit |
| modules/mission-control-chart | updated subproject commit |
| modules/mission-control | updated subproject commit |
| modules/duty | updated subproject commit |
| modules/canary-checker | updated subproject commit |
| mission-control-chart | updated subproject commit |
| mission-control/docs/reference/notifications/_silence.mdx | new reference doc for silence API fields |
| mission-control/docs/guide/notifications/concepts/silences.mdx | restructured guide with import, example block, and sections |
|
Can we add an example of a filter in a full spec. The selectors table also seems incomplete. |
adityathebe
force-pushed
the
docs/silences-crd
branch
from
e3a36a7 to
ed20f04
Compare
|
adityathebe
force-pushed
the
docs/silences-crd
branch
from
0d4f6eb to
05bb0e3
Compare
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
adityathebe
force-pushed
the
docs/silences-crd
branch
from
05bb0e3 to
4c2741b
Compare
adityathebe
force-pushed
the
docs/silences-crd
branch
from
4c2741b to
0464273
Compare
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughDocumentation for notification silences was expanded with detailed guidance on creating silences through UI, Slack templates, and custom resources, and a new reference section documenting the Silence object schema including fields for descriptions, time ranges, recursion, filters, and selectors. Changes
🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Fix all issues with AI agents
In `@mission-control/docs/guide/notifications/concepts/silences.mdx`:
- Around line 70-76: The image `silence-notification-form.png` under the
"Recursive Mode" heading is not illustrating recursive parent→child behavior;
move this image out of the "Recursive Mode" section and either place it under
the "Creating Silences" section or replace it with a new diagram that visually
depicts the parent→child relationship (namespace → deployments/statefulsets →
pods). Update the MDX around the "Recursive Mode" heading to reference the new
illustrative diagram (or add a caption) and ensure the image filename or alt
text clearly indicates whether it is the general creation form
(`silence-notification-form.png`) or the recursive relationship diagram.
- Around line 20-22: The YAML code fence in the MDX uses a non-existent file
reference and an empty title: update the code block in
mission-control/docs/guide/notifications/concepts/silences.mdx by either (a)
replacing
file=<rootDir>/modules/mission-control/fixtures/silences/silence-test-env.yaml
with a correct existing fixture path, (b) removing the file= directive and
pasting the YAML inline, or (c) deleting the whole code fence if not needed;
also remove the empty title="" or replace it with a meaningful label like
title="Example silence configuration", and delete the trailing space after the
closing backticks to ensure the block renders correctly.
In `@mission-control/docs/reference/notifications/_silence.mdx`:
- Around line 39-52: Update the Resource Selector block: rename the field key
"kind" to "types" in the Fields rows (the selector accepts resource type
patterns like "Kubernetes::Pod", "Kubernetes::*", "AWS::EC2::Instance"), and
either expand the rows to include the standard ResourceSelector fields (add
entries for namespace, labelSelector, tagSelector, id, health, statuses, etc.,
with brief descriptions and scheme types) or replace the rows with a single
sentence linking to the canonical ResourceSelector docs
(/docs/reference/resource-selector) if silences support the full API; ensure the
"name" entry remains and adjust descriptions to reflect matching patterns and
optionality.
- Around line 26-30: In _silence.mdx update the templateEnv entries so their
"url" values include the /docs prefix (i.e., change
"/reference/notifications/template_vars/checks",
"/reference/notifications/template_vars/config", and
"/reference/notifications/template_vars/components" to
"/docs/reference/notifications/template_vars/checks",
"/docs/reference/notifications/template_vars/config", and
"/docs/reference/notifications/template_vars/components"); locate the
templateEnv array in _silence.mdx and edit the three URL strings so they match
the /docs/... path used elsewhere.
🧹 Nitpick comments (2)
mission-control/docs/guide/notifications/concepts/silences.mdx (2)
30-37: Consider adding a full CR example with a filter.Per reviewer feedback, a full
NotificationSilencespec example that includes afilterfield would help users understand how to combine selectors and filters in practice. The YAML fixture imported on line 21 may partially cover this — verify it includes a filter example, and if not, consider adding a second fixture import that demonstrates one.
56-61: Long CEL expression in table cell may hurt readability.The
catalog.traverse(...)filter on line 61 is very long for a markdown table cell. Consider moving complex examples into a separate code block below the table, or breaking the expression across multiple lines with explanation.
Add silenceURL, channel, recent_events, and groupedResources to check and config event template variable docs. Fix templateEnv URLs in silence reference to use /docs/ prefix.
2 participants
resolves: #389
Summary by CodeRabbit